<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: GitCommand.html 947 2014-11-12 22:14:09Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.pobj.distrib;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.File;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.io.IOException;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.nio.charset.Charset;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.ArrayList;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.util.Arrays;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.List;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.dellroad.stuff.java.ProcessRunner;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.slf4j.Logger;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.slf4j.LoggerFactory;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * A simple wrapper around the {@code git(1)} command.<a name="line.22"></a>
<span class="sourceLineNo">023</span> */<a name="line.23"></a>
<span class="sourceLineNo">024</span>public class GitCommand {<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>    private final Logger log = LoggerFactory.getLogger(this.getClass());<a name="line.26"></a>
<span class="sourceLineNo">027</span>    private final File dir;<a name="line.27"></a>
<span class="sourceLineNo">028</span>    private final List&lt;String&gt; args = new ArrayList&lt;String&gt;();<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    private ProcessRunner runner;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Constructor.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     *<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @param dir repository filesystem location (i.e., the directory containing {@code .git} as a subdirectory)<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @param params the command line arguments (not including the initial {@code "git"})<a name="line.36"></a>
<span class="sourceLineNo">037</span>     */<a name="line.37"></a>
<span class="sourceLineNo">038</span>    public GitCommand(File dir, String... params) {<a name="line.38"></a>
<span class="sourceLineNo">039</span>        this(dir, Arrays.asList(params));<a name="line.39"></a>
<span class="sourceLineNo">040</span>    }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Constructor.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @param dir repository filesystem location (i.e., the directory containing {@code .git} as a subdirectory)<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @param params the command line arguments (not including the initial {@code "git"})<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @throws IllegalArgumentException if {@code dir} is null<a name="line.47"></a>
<span class="sourceLineNo">048</span>     */<a name="line.48"></a>
<span class="sourceLineNo">049</span>    public GitCommand(File dir, List&lt;String&gt; params) {<a name="line.49"></a>
<span class="sourceLineNo">050</span>        if (dir == null)<a name="line.50"></a>
<span class="sourceLineNo">051</span>            throw new IllegalArgumentException("null dir");<a name="line.51"></a>
<span class="sourceLineNo">052</span>        if (params == null)<a name="line.52"></a>
<span class="sourceLineNo">053</span>            throw new IllegalArgumentException("null params");<a name="line.53"></a>
<span class="sourceLineNo">054</span>        this.dir = dir;<a name="line.54"></a>
<span class="sourceLineNo">055</span>        this.args.add("git");<a name="line.55"></a>
<span class="sourceLineNo">056</span>        this.args.addAll(params);<a name="line.56"></a>
<span class="sourceLineNo">057</span>    }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Get command line arguments.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    public List&lt;String&gt; getArgs() {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        return this.args;<a name="line.63"></a>
<span class="sourceLineNo">064</span>    }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Run command. Equivalent to {@code run(false)}.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     */<a name="line.68"></a>
<span class="sourceLineNo">069</span>    public int run() {<a name="line.69"></a>
<span class="sourceLineNo">070</span>        return this.run(false);<a name="line.70"></a>
<span class="sourceLineNo">071</span>    }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Run command.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param errorOk true if a non-zero exit value may be expected<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @return {@code git(1)} exit value; if {@code errorOk} is false this will always be zero<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @throws IllegalStateException if this command has already been run<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @throws RuntimeException if the current thread is interrupted<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @throws GitException if any {@code GIT_*} environment variables are set<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @throws GitException if {@code errorOk} is false and {@code git(1}} exits with a non-zero value<a name="line.81"></a>
<span class="sourceLineNo">082</span>     */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    public int run(boolean errorOk) {<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>        // Sanity check<a name="line.85"></a>
<span class="sourceLineNo">086</span>        if (this.runner != null)<a name="line.86"></a>
<span class="sourceLineNo">087</span>            throw new IllegalStateException("command already executed");<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>        // Sanity check environment<a name="line.89"></a>
<span class="sourceLineNo">090</span>        final ArrayList&lt;String&gt; vars = new ArrayList&lt;String&gt;();<a name="line.90"></a>
<span class="sourceLineNo">091</span>        for (String var : System.getenv().keySet()) {<a name="line.91"></a>
<span class="sourceLineNo">092</span>            if (var.startsWith("GIT_"))<a name="line.92"></a>
<span class="sourceLineNo">093</span>                vars.add(var);<a name="line.93"></a>
<span class="sourceLineNo">094</span>        }<a name="line.94"></a>
<span class="sourceLineNo">095</span>        if (!vars.isEmpty())<a name="line.95"></a>
<span class="sourceLineNo">096</span>            throw new GitException("need to unset GIT_* environment variables first: " + vars);<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>        // Start process<a name="line.98"></a>
<span class="sourceLineNo">099</span>        Process process;<a name="line.99"></a>
<span class="sourceLineNo">100</span>        try {<a name="line.100"></a>
<span class="sourceLineNo">101</span>            process = Runtime.getRuntime().exec(args.toArray(new String[args.size()]), null, this.dir);<a name="line.101"></a>
<span class="sourceLineNo">102</span>        } catch (IOException e) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>            this.log.debug("command `" + this + "' in directory `" + this.dir + "' failed: ", e);<a name="line.103"></a>
<span class="sourceLineNo">104</span>            throw new GitException("error invoking git(1)", e);<a name="line.104"></a>
<span class="sourceLineNo">105</span>        }<a name="line.105"></a>
<span class="sourceLineNo">106</span>        this.runner = new ProcessRunner(process);<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>        // Let it finish<a name="line.108"></a>
<span class="sourceLineNo">109</span>        int exitValue;<a name="line.109"></a>
<span class="sourceLineNo">110</span>        try {<a name="line.110"></a>
<span class="sourceLineNo">111</span>            exitValue = this.runner.run();<a name="line.111"></a>
<span class="sourceLineNo">112</span>        } catch (InterruptedException e) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>            throw new RuntimeException("unexpected exception", e);      // XXX<a name="line.113"></a>
<span class="sourceLineNo">114</span>        }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>        // Log command output<a name="line.116"></a>
<span class="sourceLineNo">117</span>        final StringBuilder buf = new StringBuilder();<a name="line.117"></a>
<span class="sourceLineNo">118</span>        final String[] stdout = this.getStandardOutput().trim().split("\n");<a name="line.118"></a>
<span class="sourceLineNo">119</span>        if (!(stdout.length == 1 &amp;&amp; stdout[0].length() == 0)) {<a name="line.119"></a>
<span class="sourceLineNo">120</span>            for (String line : stdout)<a name="line.120"></a>
<span class="sourceLineNo">121</span>                buf.append("\n  [stdout] ").append(line);<a name="line.121"></a>
<span class="sourceLineNo">122</span>        }<a name="line.122"></a>
<span class="sourceLineNo">123</span>        final String[] stderr = this.getStandardError().trim().split("\n");<a name="line.123"></a>
<span class="sourceLineNo">124</span>        if (!(stderr.length == 1 &amp;&amp; stderr[0].length() == 0)) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>            for (String line : stderr)<a name="line.125"></a>
<span class="sourceLineNo">126</span>                buf.append("\n  [stderr] ").append(line);<a name="line.126"></a>
<span class="sourceLineNo">127</span>        }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>        // Check exit value<a name="line.129"></a>
<span class="sourceLineNo">130</span>        if (exitValue != 0) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>            final String msg = "command `" + this + "' in directory `" + this.dir + "' failed with exit value " + exitValue;<a name="line.131"></a>
<span class="sourceLineNo">132</span>            if (errorOk)<a name="line.132"></a>
<span class="sourceLineNo">133</span>                this.log.debug(msg);<a name="line.133"></a>
<span class="sourceLineNo">134</span>            else {<a name="line.134"></a>
<span class="sourceLineNo">135</span>                this.log.error(msg);<a name="line.135"></a>
<span class="sourceLineNo">136</span>                throw new GitException(msg);<a name="line.136"></a>
<span class="sourceLineNo">137</span>            }<a name="line.137"></a>
<span class="sourceLineNo">138</span>        } else<a name="line.138"></a>
<span class="sourceLineNo">139</span>            this.log.debug("successfully executed command `" + this + "' in directory `" + this.dir + "'" + buf);<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>        // Done<a name="line.141"></a>
<span class="sourceLineNo">142</span>        return exitValue;<a name="line.142"></a>
<span class="sourceLineNo">143</span>    }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    /**<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Run command and return standard output, interpreted as a UTF-8 string, with leading and trailing whitespace trimmed.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     *<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * @throws IllegalStateException if this command has already been run<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @throws RuntimeException if the current thread is interrupted<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * @throws GitException if any {@code GIT_*} environment variables are set<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @throws GitException if {@code git(1}} exits with a non-zero value<a name="line.151"></a>
<span class="sourceLineNo">152</span>     */<a name="line.152"></a>
<span class="sourceLineNo">153</span>    public String runAndGetOutput() {<a name="line.153"></a>
<span class="sourceLineNo">154</span>        this.run();<a name="line.154"></a>
<span class="sourceLineNo">155</span>        return this.getStandardOutput().trim();<a name="line.155"></a>
<span class="sourceLineNo">156</span>    }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span>    /**<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * Get the standard output from {@code git(1)}.<a name="line.159"></a>
<span class="sourceLineNo">160</span>     *<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * @throws IllegalStateException if command has not yet completed<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * @return command standard output interpreted as UTF-8<a name="line.162"></a>
<span class="sourceLineNo">163</span>     */<a name="line.163"></a>
<span class="sourceLineNo">164</span>    public String getStandardOutput() {<a name="line.164"></a>
<span class="sourceLineNo">165</span>        if (this.runner == null)<a name="line.165"></a>
<span class="sourceLineNo">166</span>            throw new IllegalStateException("command has not yet executed");<a name="line.166"></a>
<span class="sourceLineNo">167</span>        return new String(this.runner.getStandardOutput(), Charset.forName("UTF-8"));<a name="line.167"></a>
<span class="sourceLineNo">168</span>    }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span>    /**<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * Get the standard error from {@code git(1)}.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     *<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * @throws IllegalStateException if command has not yet completed<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * @return command standard error interpreted as UTF-8<a name="line.174"></a>
<span class="sourceLineNo">175</span>     */<a name="line.175"></a>
<span class="sourceLineNo">176</span>    public String getStandardError() {<a name="line.176"></a>
<span class="sourceLineNo">177</span>        if (this.runner == null)<a name="line.177"></a>
<span class="sourceLineNo">178</span>            throw new IllegalStateException("command has not yet executed");<a name="line.178"></a>
<span class="sourceLineNo">179</span>        return new String(this.runner.getStandardError(), Charset.forName("UTF-8"));<a name="line.179"></a>
<span class="sourceLineNo">180</span>    }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span>    @Override<a name="line.182"></a>
<span class="sourceLineNo">183</span>    public String toString() {<a name="line.183"></a>
<span class="sourceLineNo">184</span>        final StringBuilder buf = new StringBuilder();<a name="line.184"></a>
<span class="sourceLineNo">185</span>        for (String arg : this.args) {<a name="line.185"></a>
<span class="sourceLineNo">186</span>            if (buf.length() &gt; 0)<a name="line.186"></a>
<span class="sourceLineNo">187</span>                buf.append(' ');<a name="line.187"></a>
<span class="sourceLineNo">188</span>            buf.append(arg);<a name="line.188"></a>
<span class="sourceLineNo">189</span>        }<a name="line.189"></a>
<span class="sourceLineNo">190</span>        return buf.toString();<a name="line.190"></a>
<span class="sourceLineNo">191</span>    }<a name="line.191"></a>
<span class="sourceLineNo">192</span>}<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>




























































</pre>
</div>
</body>
</html>
